'\" te
.\"  Copyright 1989 AT&T Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH BGETS 3GEN "March 10, 2023"
.SH NAME
bgets \- read stream up to next delimiter
.SH SYNOPSIS
.nf
cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lgen\fR [ \fIlibrary\fR ... ]
#include <libgen.h>

\fBchar *\fR\fBbgets\fR(\fBchar *\fR\fIbuffer\fR, \fBsize_t\fR \fIcount\fR, \fBFILE  *\fR\fIstream\fR,
     \fBconst char *\fR\fIbreakstring\fR);
.fi

.SH DESCRIPTION
The \fBbgets()\fR function reads characters from \fIstream\fR into \fIbuffer\fR
until either \fIcount\fR is exhausted or one of the characters in
\fIbreakstring\fR is encountered in the stream. The read data is terminated
with a null byte ('\fB\e0\fR\&') and a pointer to the trailing null is
returned. If a \fIbreakstring\fR character is encountered, the last non-null is
the delimiter character that terminated the scan.
.sp
.LP
Note that, except for the fact that the returned value points to the \fBend\fR
of the read string rather than to the beginning, the call
.sp
.in +2
.nf
bgets(buffer, sizeof buffer, stream, "\en");
.fi
.in -2

.sp
.LP
is identical to
.sp
.in +2
.nf
fgets (buffer, sizeof buffer, stream);
.fi
.in -2

.sp
.LP
There is always enough room reserved in the buffer for the trailing null
character.
.sp
.LP
If \fIbreakstring\fR is a null pointer, the value of \fIbreakstring\fR from the
previous call is used. If \fIbreakstring\fR is null at the first call, no
characters will be used to delimit the string.
.SH RETURN VALUES
\fINULL\fR is returned on error or end-of-file.  Reporting the condition is
delayed to the next call if any characters were read but not yet returned.
.SH EXAMPLES
\fBExample 1 \fRExample of the \fBbgets()\fR function.
.sp
.LP
The following example prints the name of the first user encountered in
\fB/etc/passwd\fR, including a trailing ":"

.sp
.in +2
.nf
#include <stdio.h>
#include <libgen.h>

int main()
{
    char buffer[8];
    FILE *fp;

    if ((fp = fopen("/etc/passwd","r")) == NULL) {
        perror("/etc/passwd");
        return 1;
    }
    if (bgets(buffer, 8, fp, ":") == NULL) {
        perror("bgets");
        return 1;
    }
    (void) puts(buffer);
    return 0;
}
.fi
.in -2

.SH ATTRIBUTES
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.BR gets (3C),
.BR attributes (7)
.SH NOTES
When compiling multithread applications, the \fB_REENTRANT\fR flag must be
defined on the compile line.  This flag should only be used in multithreaded
applications.
